dxp-ux

(0 reviews)

Get Customer (TMF-629)

List Customer Details

CSG FIXED CUSTOMERS

This operation allows for the listing of Customer entities with operations that enable users to retrieve the customers with operation GET from the system and apply the transformations if required to maintain the standards with TMF.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/customer

Common Parameters

Base URI parameters and headers are common to all the resources as part of customer management Biz API, listed below with details.

for PR

http://[localhost]:[port]/dxp-ux/v1/PR/customer?identityNumber=7777777777&identityType=PN

Base URI Parameter

Name	Type	M/O	Description
businessId	string	M	Business unit identifier. Example: “JM”,“PA”,“PR”,“CR”

Headers

name	value	description	required
Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	O
channeId	string	Channel to business: Expected Value: "ECOM" Note ChannelId default value:ECOM	O
lob	String	Enum: PREPAID, POSTPAID,FIXED Expected value : FIXED	O
targetSystem	string	Use this data type to indicate target system name/id in your request. Expected value as 'csg' Note: If we won't pass this header targetSystem it will route to other exisiting implementation.	O

Security Headers

name	value	description	required
client_id	string	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg:6f0ed16a7b494d76b2d60e05bc3b3332	M
client_secret	string	Client secret value for Client Id Enforcement policy. Environment Specific Value Eg: e4CD4D43449846aA9D8Cb9c43fAd324a	M

Query Param

name	type	description	required
identityType	string	For PR Market. PN = Phone number, AN = Account number, identityType is named as key in sys layer. Key will displayed in error response when we miss this field. Example - For PR - AN, PN	M
identityNumber	string	For PR Market. identityNumber is named as keyType in sys layer. KeyType will displayed in error response when we miss this field. Example - For PR - 7306179999, 8211990010034312	M

HTTP Status response is 200

PR Market Response.


[
    {
        "id": "1101521301346",
        "name": "ANGEL  MARTINEZ",
        "account": [
            {
                "id": "8211990010012706"
            }
        ],
        "contactMedium": [
            {
                "characteristic": {
                    "phoneNumber": "7872100000"
                }
            }
        ]
    }
]

Response Model

name	type	required	description
@type	string	O	When sub-classing, this defines the sub-class entity name
href	String	O	Url used to reference the customer.
Id	string	O	Unique identifier for Customers
Name	string	O	A word, term, or phrase by which the Customer is known and distinguished from other Customers.
Account[]	Array of Object	O	Account reference. A account may be a party account or a financial account.
Account[].id	String	O	Unique identifier of the account
contactMedium[]	Array of Object	O	Indicates the contact medium that could be used to contact the party.
contactMedium[].characteristic	Object	M	Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
contactMedium[].characteristic.phoneNumber	string	O	The Phone number

Possible Error Response

400

{
    "errors": [
        {
            "code": 400,
            "message": "CSG: Error while retrieving the customer information",
            "description": "2099   ** CIP09W - UNABLE TO XREF SUB PREFIX"
        }
    ]
}